doc/creating-an-application: Add Section about Makefile.board.dep #21475
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
crasbe
added
Type: enhancement
crasbe
added
the
Impact: minor
mguetschow
reviewed
May 8, 2025
The existance of the `Makefile.board.dep` files in application directories was previously undocumented, but used throughout the RIOT example applications.
Teufelchen1
approved these changes
May 16, 2025
miri64
reviewed
May 16, 2025
Member
miri64
left a comment
miri64
left a comment
There was a problem hiding this comment.
Wasn't able to review during the meeting, but have one nit.
Comment on lines
+112
to
+115
| target board or architecture. This is especially | ||
| relevant for networking applications where multiple hardware implementations | ||
| exist and the appropriate one has to be chosen for the given board | ||
| or architecture. |
Member
There was a problem hiding this comment.
Suggested change
| target board or architecture. This is especially | |
| relevant for networking applications where multiple hardware implementations | |
| exist and the appropriate one has to be chosen for the given board | |
| or architecture. | |
| target board or architecture. This is especially | |
| relevant for networking applications where multiple hardware implementations | |
| exist and the appropriate implementation has to be chosen for the given board | |
| or architecture. |
? Not 100% sure what "one" is referring to here, so better clarify.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
5 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The existance of the
Makefile.board.depfiles in application directories was previously undocumented, but used throughout the RIOT example applications.Contribution description
The possibility to create a board-specific
Makefile.depin the application folder was introduced in #12755, but no further documentation about it was added.This is unfortunate, because it's used throughout RIOT already and a very useful feature, since that file (unlike the application Makefile) will be called throughout the dependency resolution phase and therefore have the latest and updated
FEATURES_USED,USEMODULE, ... variables.Testing procedure
Look at the generated Doxygen documentation.
Issues/PRs references
The feature was introduced in #12755.
The lack of documentation came up in #21442.